<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Birt Editor Form Page</title>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/plugins/org.eclipse.platform_3.3.200.v200908070800/book.css");</style>
<style type="text/css">@import url("file:/C:/JAHT/eclipse/configuration/org.eclipse.osgi/bundles/170/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Birt Editor Form Page</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.birt.report.designer.ui.formPage<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>2.1.0
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used to contributor embedded editor into BIRT mulipage report editor.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.targetEditor">targetEditor</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.formPage">formPage</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST formPage</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">displayName&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">visible&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true|false) "true"</p><p class="code SchemaDtdAttlist">relative&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">position&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(left|right) </p><p class="code SchemaDtdAttlist">priority&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(high|normal|low) "normal"</p><p class="code SchemaDtdAttlist">pageAction&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">actionBarContributor&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - </li>
<li><b>displayName</b> - </li>
<li><b>class</b> - </li>
<li><b>icon</b> - </li>
<li><b>visible</b> - </li>
<li><b>relative</b> - </li>
<li><b>position</b> - </li>
<li><b>priority</b> - </li>
<li><b>pageAction</b> - </li>
<li><b>actionBarContributor</b> - </li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.targetEditor">targetEditor</a> (<a href="#e.formPage">formPage</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST targetEditor</p>
<p class="code SchemaDtdAttlist">targetEditorId&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>targetEditorId</b> - </li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example :
   <extension
         point="org.eclipse.birt.report.designer.ui.editors.multiPageEditorContributor">
      <targetEditor targetEditorId="org.eclipse.birt.report.designer.ui.editors.ReportEditor">
      <formPage
            class="org.eclipse.birt.report.designer.ui.editors.pages.ReportLayoutEditorFormPage"
            displayName="%design.layout"
            id="org.eclipse.birt.report.designer.ui.editors.design.layout"
            visible="true"/>
      <formPage
            class="org.eclipse.birt.report.designer.ui.editors.pages.ReportMasterPageEditorFormPage"
            displayName="%design.masterPage"
            id="org.eclipse.birt.report.designer.ui.editors.design.masterpage"
            visible="true"/>
      <formPage
            class="org.eclipse.birt.report.designer.ui.editors.pages.ReportScriptFormPage"
            displayName="%design.script"
            id="org.eclipse.birt.report.designer.ui.editors.design.script"
            visible="true"/>
      <formPage
            class="org.eclipse.birt.report.designer.ui.editors.pages.ReportPreviewFormPage"
            displayName="%design.preview"
            id="org.eclipse.birt.report.designer.ui.editors.design.preview"
            visible="true"/>
      <formPage
            class="org.eclipse.birt.report.designer.ui.editors.pages.ReportXMLSourceEditorFormPage"
            displayName="%design.xmlsource"
            id="org.eclipse.birt.report.designer.ui.editors.design.xmlsource"
            visible="true"/>
      </targetEditor>
   </extension>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The report item UI extension should implement the IReportEditorPage interface defined in the <i>org.eclipse.birt.report.designer.ui.editors</i> package. See the package's JavaDoc documentation and API interfaces for more information.
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The plugin <i>org.eclipse.birt.report.designer.ui.editors.schematic</i>, supplied with the BIRT installation, provides a good example for implementing a multip page editor contributor extension point.
<br>
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2005 Actuate Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-2.0.html

Contributors: Actuate Corporation - initial API and implementation

</p>
</BODY>
</HTML>
